/*
 * Copyright 2021 OPPO ESA Stack Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.esastack.restlight.core.context;

import esa.commons.collection.Attributes;

import java.util.function.Consumer;

public interface RequestContext {

    /**
     * Obtains current {@code request}.
     *
     * @return request
     */
    HttpRequest request();

    /**
     * Obtains current {@code response}.
     *
     * @return response
     */
    HttpResponse response();

    /**
     * Obtains {@link Attributes} corresponding with current {@link RequestContext}.
     *
     * @return attributes
     */
    Attributes attrs();

    /**
     * Add a listener to this requestContext, this listener will be called after current response has been write.
     *
     * @param listener listener
     */
    RequestContext onEnd(Consumer<RequestContext> listener);
}

